Typen von Dokumentationskapiteln

Typen von Kapitel

In einer Dokumentationsstruktur können Sie unterschiedliche Kapiteltypen verwenden. Man unterscheidet zwischen den Standardkapiteln, zu denen Informationskapitel und Modellelementaufzählungskapitel gehören, zusätzlichen Gliederungskapiteln, Dokumentationsbausteinen und Verweisen auf Dokumentationsbausteinen. Der Inhalt von Modellelementaufzählungskapiteln kann auch tabellarisch ausgegeben werden.

Informationskapitel

Informationskapitel sind Blattknoten der Dokumentationsstruktur. In ihnen werden Informationen zu einem Modellelement ausgegeben, wie zum Beispiel der letzte Bearbeiter. Ein solches Kapitel besteht aus Überschrift und Inhalt, wobei die Überschrift unterdrückt werden kann.

Informationskapitel werden im Konfigurationseditor nur in der Liste der zugeordneten Standardkapitel im mittleren Bereich ausgegeben. Dort sind sie mit dem Symbol "i" gekennzeichnet. In der Liste Dokumentationsstrukturen im linken Bereich werden sie der Übersichtlichkeit halber nicht dargestellt.

Es gibt einige Informationskapitel, die eine spezielle Bedeutung haben:

• Inhaltsverzeichnis, Index und Abbildungsverzeichnis
• Prüfkapitel
• Abbildungskapitel

Modellelementaufzählungskapitel

Modellelementaufzählungskapitel liefern zu einem Modellelement eine Menge von abhängigen Modellelementen, wie zum Beispiel zu einer Klasse alle Attribute. Unter einem solchen Kapitel können sich weitere Standardkapitel, zusätzliche Gliederungskapitel oder Verweise auf Bausteine befinden.

Ein Modellelementaufzählungskapitel besteht aus einer Überschrift, unter die für jedes abhängige Modellelement eine Modellelementüberschrift generiert wird, die typischerweise den Namen dieses Elements enthält. Bei der Erstellung der Dokumentation kann man diese Modellelementüberschriften in Spiegelstrichlisteneinträge umwandeln.

Modellelementaufzählungskapitel werden im Konfigurationseditor sowohl in der Spalte "Dokumentationsstrukturen" als auch im mittleren Bereich dargestellt. Im letzteren sind sie durch das Symbol ... gekennzeichnet.

Zusätzliche Gliederungskapitel

Zusätzliche Gliederungskapitel sind ein Strukturierungselement, das es Ihnen erlaubt zusätzliche Überschriften in die Dokumentation einzufügen.

Dokumentationsbausteine und Verweise auf Dokumentationsbausteine

Dokumentationsbausteine dienen der Wiederverwendung von Teilbäumen einer Dokumentationsstruktur. Über Verweise können Sie an passenden Stellen in der Dokumentationsstruktur eingefügt werden.

Im Konfigurationseditor werden die Verweise im linken und mittleren Bereich dargestellt. Bei selektiertem Verweis im linken Bereich wird der Baustein im mittleren Bereich dargestellt.

In der Ansicht Dokumentation werden bei Selektion des Dokumentationsbausteins im linken Bereich die dazugehörenden Verweise im rechten Bereich ausgegeben.